package com.ylxl.common.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
 * @Author: Gilbert
 * @Date: 2021/9/3 18:07
 * @Description:
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
        /** 系统基础配置 */
        @Autowired
        private YlxlConfig ylxlConfig;

        /** 是否开启swagger */
        @Value("${swagger.enabled}")
        private boolean enabled;

        /** 设置请求的统一前缀 */
        @Value("${swagger.pathMapping}")
        private String pathMapping;

    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     */
    @Bean
    public Docket createRestApi() {

        List<Parameter> pars = new ArrayList<Parameter>();
        return new Docket(DocumentationType.SWAGGER_2)
                // 是否启用Swagger
                .enable(enabled)
                .apiInfo(apiInfo())
                .groupName("显示屏后台管理系统")
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars)
                .pathMapping(pathMapping)
                .apiInfo(apiInfo());
    }

        /**
         * swagger地址
         * http://localhost:10087/back-stage/doc.html
         * 添加摘要信息
         */
        private ApiInfo apiInfo()
        {
            // 用ApiInfoBuilder进行定制
            return new ApiInfoBuilder()
                    // 设置标题
                    .title("标题：显示屏后台管理系统_接口文档")
                    // 描述
                    .description("描述：用于显示屏后台管理,具体包括XXX,XXX模块...")
                    // 作者信息
                    .contact(new Contact(ylxlConfig.getName(), null, null))
                    // 版本
                    .version("版本号:" + ylxlConfig.getVersion())
                    .build();
        }
}
